rename Menu components #2996
Open
rename Menu components #2996
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juliawegmayr
force-pushed
the
rename-components-of-main-navigation
branch
3 times, most recently
from
68f98e9 to
e5be58b
Compare
juliawegmayr
force-pushed
the
rename-components-of-main-navigation
branch
2 times, most recently
from
2774972 to
e31290c
Compare
juliawegmayr
force-pushed
the
rename-components-of-main-navigation
branch
from
e31290c to
2461d1d
Compare
juliawegmayr
requested review from
jamesricky
and removed request for
jamesricky
jamesricky
reviewed
Dec 30, 2024
jamesricky
previously approved these changes
Dec 30, 2024
jamesricky
reviewed
Dec 30, 2024
jamesricky
approved these changes
Jan 2, 2025
johnnyomair
reviewed
Jan 9, 2025
Comment on lines
+204
to
+213
| export { MainNavigationCollapsibleItem, MainNavigationCollapsibleItemProps } from "./mui/mainNavigation/CollapsibleItem"; | ||
| export { MainNavigationCollapsibleItemClassKey } from "./mui/mainNavigation/CollapsibleItem.styles"; | ||
| export { MainNavigationContext, MainNavigationContextValue, WithMainNavigation, withMainNavigation } from "./mui/mainNavigation/Context"; | ||
| export { MainNavigationItem, MainNavigationItemProps } from "./mui/mainNavigation/Item"; | ||
| export { MainNavigationItemClassKey } from "./mui/mainNavigation/Item.styles"; | ||
| export { MainNavigationItemAnchorLink, MainNavigationItemAnchorLinkProps } from "./mui/mainNavigation/ItemAnchorLink"; | ||
| export { MainNavigationItemGroup, MainNavigationItemGroupClassKey, MainNavigationItemGroupProps } from "./mui/mainNavigation/ItemGroup"; | ||
| export { MainNavigationItemRouterLink, MainNavigationItemRouterLinkProps } from "./mui/mainNavigation/ItemRouterLink"; | ||
| export { MainNavigation, MainNavigationProps } from "./mui/mainNavigation/MainNavigation"; | ||
| export { MainNavigationClassKey } from "./mui/mainNavigation/MainNavigation.styles"; |
There was a problem hiding this comment.
Now maybe a good time to ask whether we actually need all these exports. For instance, none of our projects use withMenu. @jamesricky what do you think?
| import { IMenuContext } from "./Context"; | ||
| import { MenuItem as CometMenuItem, MenuItemLevel } from "./Item"; | ||
| import { MainNavigationContextValue } from "./Context"; | ||
| import { MainNavigationItem as CometMainNavigationItem, MainNavigationItemLevel } from "./Item"; |
There was a problem hiding this comment.
It shouldn't be necessary to have import alias inside the same package IMO.
| @@ -0,0 +1,28 @@ | |||
| import { ComponentType, createContext, Dispatch, FunctionComponent, SetStateAction } from "react"; | |||
|
|
|||
| export interface MainNavigationContextValue { | |||
There was a problem hiding this comment.
TypeScript supports both a type and a variable with the same name, so we don't need the Value suffix.
| @@ -201,18 +201,18 @@ export { useStoredState } from "./hooks/useStoredState"; | |||
| export { InputWithPopper, InputWithPopperComponents, InputWithPopperProps } from "./inputWithPopper/InputWithPopper"; | |||
| export { InputWithPopperClassKey } from "./inputWithPopper/InputWithPopper.slots"; | |||
| export { messages } from "./messages"; | |||
| export { MainNavigationCollapsibleItem, MainNavigationCollapsibleItemProps } from "./mui/mainNavigation/CollapsibleItem"; | |||
| export { MainNavigationCollapsibleItemClassKey } from "./mui/mainNavigation/CollapsibleItem.styles"; | |||
| export { MainNavigationContext, MainNavigationContextValue, WithMainNavigation, withMainNavigation } from "./mui/mainNavigation/Context"; | |||
There was a problem hiding this comment.
I'd suggest to not export the context and create a useMainNavigation() or useMainNavigationApi() hook instead.
|
Now we have the terms main navigation and master menu for related, but different things. Might this confuse devs? @jamesricky what do you think? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Rename all Menu components to better differentiate between comet and mui components:
Acceptance criteria
Open TODOs/questions
Further information